Help/Extending and Customizing SC/Using-Extensions.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="949.46">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Helvetica}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica; min-height: 17.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #001bec}
  13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
  14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
  15 p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
  16 p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
  17 span.s1 {color: #000000}
  18 span.s2 {text-decoration: underline}
  19 span.s3 {color: #002ff6}
  20 span.s4 {color: #001dfd}
  21 span.s5 {text-decoration: underline ; color: #001bec}
  22 span.s6 {color: #002bb0}
  23 span.Apple-tab-span {white-space:pre}
  24 </style>
  25 </head>
  26 <body>
  27 <p class="p1"><b>Using Extensions</b></p>
  28 <p class="p2"><br></p>
  29 <p class="p3"><span class="s1">See also: <a href="Writing-Classes.html"><span class="s2">Writing-Classes</span></a><b><span class="Apple-converted-space">    </span></b><a href="Writing_Unit_Generators.html"><span class="s2">Writing_Unit_Generators</span></a></span><span class="s3"> <span class="Apple-converted-space"> </span></span><span class="s4"> <a href="Quarks/Quarks.html"><span class="s5">Quarks</span></a></span></p>
  30 <p class="p2"><br></p>
  31 <p class="p4">SC supports extensions to its class library, documentation, and server UGen plugins. Extensions should be packaged as a single folder containing all three (for convenient addition or removal), or any combination, which can then be placed in platform-specific extension directories in order to be included.</p>
  32 <p class="p5"><br></p>
  33 <p class="p6"><b>Platform Specific Directories</b></p>
  34 <p class="p5"><br></p>
  35 <p class="p4">You can install extensions simply by copying the extensions to the following location:</p>
  36 <p class="p5"><br></p>
  37 <p class="p4"><b>User-specific</b></p>
  38 <p class="p4">OSX<b><span class="Apple-tab-span">       </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></b>~/Library/Application Support/SuperCollider/Extensions/</p>
  39 <p class="p4">Linux<b><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></b>~/share/SuperCollider/Extensions/</p>
  40 <p class="p5"><br></p>
  41 <p class="p7"><span class="s6">Platform</span>.userExtensionDir</p>
  42 <p class="p5"><br></p>
  43 <p class="p5"><br></p>
  44 <p class="p4"><b>System-wide (apply to all users)</b></p>
  45 <p class="p4">OSX<b><span class="Apple-tab-span">       </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></b>/Library/Application Support/SuperCollider/Extensions/</p>
  46 <p class="p4">Linux<b><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></b>/usr/local/share/SuperCollider/Extensions/</p>
  47 <p class="p5"><br></p>
  48 <p class="p7"><span class="s6">Platform</span>.systemExtensionDir</p>
  49 <p class="p5"><br></p>
  50 <p class="p5"><br></p>
  51 <p class="p6"><b>How Extensions Folders Should be Organised</b></p>
  52 <p class="p5"><br></p>
  53 <p class="p4">Class files and UGen plugins are recognised by their file extensions (.sc for the former and .scx or .sco for the latter). Anything placed within a folder named help/ or ignore/ (case insensitive) will be ignored when compiling the class library or loading plugins, but anything in the former will be added to the search path for help files.</p>
  54 <p class="p5"><br></p>
  55 <p class="p4">Here is an example folder layout:</p>
  56 <p class="p5"><br></p>
  57 <p class="p4"><span class="Apple-tab-span">     </span>MyExtension/</p>
  58 <p class="p5"><span class="Apple-tab-span">     </span></p>
  59 <p class="p4"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>classes/</p>
  60 <p class="p4"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>myClass.sc <span class="Apple-tab-span"> </span>myUGens.sc</p>
  61 <p class="p4"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>plugins/</p>
  62 <p class="p4"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>myUGenPlugins.scx</p>
  63 <p class="p4"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>help/</p>
  64 <p class="p4"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>myClass.html <span class="Apple-tab-span">       </span>myUGen1.html<span class="Apple-tab-span">        </span>myUGen2.html</p>
  65 <p class="p5"><br></p>
  66 <p class="p2"><br></p>
  67 </body>
  68 </html>